home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / doorware / hilo14.zip / HILO.DOC < prev    next >
Text File  |  1996-02-02  |  25KB  |  553 lines

  1.  
  2.                               H I  -  L O 
  3.  
  4.                                   v1.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                 (404) 256-9525 (USR v.everything 28.8)
  12.                 (404) 705-9104 (USR v.everything 28.8)
  13.                 (404) 256-9518 (9am-9:30pm EST ANY DAY)
  14.                     (EMAIL) al_lawre@ix.netcom.com
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22.    HILO is a fast-paced card game where the player must guess whether the card
  23.    being drawn from the deck, will be LOWER or HIGHER than the card displayed on
  24.    the triangular board. InterBBS capabale, Bonus applied for clearing the board 
  25.    and point loss for wrong guesses.
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                 NON-REGISTERED   R E S T R I C T I O N S
  33.                 ----------------------------------------
  34.  
  35.                 ° No Bulletins created
  36.                 ° Games per day limited to 2
  37.                 ° Keyboard timeout value limited to 2 minutes
  38.                 ° Makeup days disabled
  39.                 ° Game time limit disabled
  40.                 ° Bonus Value must be 1000 points
  41.                 ° Can not send/receive messages to/from other players
  42.  
  43.  
  44.  
  45.  
  46.                               INSTALLATION
  47.                               ____________
  48.  
  49.  
  50.    Installation is fairly easy and straight-forward. The following steps and
  51.    examples should have you up and running in a very short period of time.
  52.    It is assumed that you are familiar with setting up DOORS on your system.
  53.    To this end, only examples of the configuration file and Door batch file
  54.    are described.
  55.  
  56.       1) Create a directory to hold all HILO files
  57.  
  58.       2) Unzip HILOxx.ZIP into the the above directory
  59.  
  60.       3) Create a configuration file, with a name of your choice, or
  61.          modify the supplied HILO.CFG file. A description follows:
  62.  
  63.             **                       Location of system file (See Below)
  64.             SUNRISE-80 BBS           Your BBS Name
  65.             Al                       Sysop's First nameAP
  66.  
  67.             Lawrence                 Sysop's Last Name
  68.  
  69. |-----------------------------------------------------------------------------|
  70. | READ!     1                        CommPort  \ These 2 lines are required   |
  71. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  72. |-----------------------------------------------------------------------------|
  73.  
  74.             00000000                 Registration Number
  75.  
  76.    !    #   2                        Maximum # of Games per day (MAX=26)
  77.                                      (Sysop gets 26 in Registered version)
  78.  
  79.         #   0                        Max # of days a caller can make up, during
  80.                                      calls in one day. 0=Disable Make-up Option
  81.                                      Maximum value = 27, Minimum value = 1
  82.  
  83.         #   NONE                     Drive:\Path\Filename to contain the
  84.                                      Top Score Bulletin or enter NONE
  85.                                      for NO Bulletin creation.
  86.  
  87.         #   NONE                     Drive:\Path\Filename to contain the
  88.                                      Top Score Bulletin (Color) or enter NONE
  89.                                      for NO Bulletin creation.
  90.  
  91.         #   NONE                     Drive:\Path\Filename to contain the
  92.                                      Hall of Fame Bulletin or enter NONE
  93.                                      for NO Bulletin creation.
  94.  
  95.         #   NONE                     Drive:\Path\Filename to contain the
  96.                                      Hall of Fame Bulletin (Color) or enter NONE
  97.                                      for NO Bulletin creation.
  98.  
  99.             1                        1 = DO NOT Display ADOPT-A-DOOR Message
  100.                                      2 = Display ADOPT-A-DOOR message
  101.  
  102.         #   2                        Keyboard timeout value in Minutes
  103.  
  104.     !   #   0                        Time Allowed in Door
  105.                                      (Sysop = Time Remaining - REG. VERSION)
  106.  
  107.         #   N                        Automatic game reset at end of month:
  108.                                        Y = Yes enable autoreset
  109.                                        N = Keep accumulating scores
  110.  
  111.         #   Y                        Y = Allow Sysop to have 26 games
  112.                                      N = Do Not Allow Sysop 26 games
  113.  
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  124.  
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.     @   #   XXXX/YYYY                 Blackout Range  From/To
  130.  
  131.             000                       Unique 3-digit number used as a suffix
  132.                                       for the exported score file name, if
  133.                                       you wish to paricipate in an Inter-BBS
  134.                                       game. 000=no Inter-BBS participation.
  135.  
  136.         #   1000                     Bonus earned if ALL Cards are removed
  137.  
  138.             N                         Y = Force Caller to respond to
  139.                                           Instructions <y/n). May need this with
  140.                                           Digiboards.
  141.                                       N = Allow caller to press ENTER in
  142.                                           response to Instructions <y/N>
  143.  
  144.             0                         Use this option to LIMIT the number of
  145.                                       HIGH SCORE entries to be displayed. A
  146.                                       ZERO(0) = NO LIMIT
  147.  
  148.             0                         Number of months to keep in the SUNHOF
  149.                                       files (Hall of Fame). 0 = ALL
  150.  
  151.             N                         Y = Use Alias for Caller's name
  152.                                           (Requires Door.Sys)
  153.                                       N = Use Logon Name for Caller's name
  154.  
  155.      
  156.         #   Y                         Y = Allow Messages to be sent/received
  157.                                       N = Do NOT allow messages to be sent/read
  158.  
  159.  
  160.           ** = Replace with ONE of the following:
  161.  
  162. C:\bbs\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  163. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  164. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  165. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  166. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  167. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  168. C:\BBS\GTUSER.BBS               <- For GT Power
  169.                                    * if using this option you must put the
  170.                                      ComPort # on line 5 and the Node # on
  171.                                      line 6 of the configuration file
  172.  
  173.  
  174.            # = Requires registration to change to a different value.
  175.            ! = See "Plays Per Day/Door Time" Below
  176.            @ = See "Blackout Periods" Below
  177.  
  178.                NOTE: There are NO Blank Lines in the Config File!!
  179.  
  180.  
  181.       4) Create a batch file or modify the HILO file supplied. A description 
  182.          of this file follows:
  183.  
  184.             ECHO off
  185.             cd\BBS\DOORS\HILO         Location of HILO files
  186.             HILO HILO.CFG             EXE filename and CFG filename (Name
  187.                                       used in creating file in #3 above)
  188.             CD\BBS
  189.             BOARD
  190.  
  191.  
  192.        5) When running in more than one node, be sure to supply a
  193.           different configuration name for each node (or see below).
  194.  
  195.        6) If running with a Fossil-based multi-port board add
  196.            /FD to the line containing the CFG name as follows:
  197.  
  198.                           HILO HILO.CFG /FD
  199.  
  200.  
  201.  
  202.  
  203.  
  204.                MAKE-UP DAYS (Registered version only)
  205.                --------------------------------------
  206.  
  207. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  208. during the current month and prior to the current call. You control whether
  209. to allow this option, as well as the number of days the caller can make up, on
  210. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  211. configuration file, turns the option OFF, any other value (up to a max of 27)
  212. turns the option ON and dictates the number of days the caller can make up.
  213.  
  214.  
  215. NOTE:      The number of games per day is calculated as follows...
  216.  
  217.            Games Allowed per day x Number of makeup days.
  218.  
  219. Example:   Games Allowed per day = 2
  220.            Max # of makeup days  = 4
  221.  
  222. If a caller logs in on 5/8/92 and this is their first call of the month, they
  223. would have a potential of 16 games to makeup and bring them current
  224. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  225. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  226. (games allowed * max # of makeup days).
  227.  
  228.  
  229.  
  230.              HALL OF FAME BULLETINS (Registered version only)
  231.              ------------------------------------------------
  232.  
  233. The program will automatically reset the game when the first caller of the
  234. month plays the game. The score file will be cleared and a set of Hall of Fame
  235. files will be created. The files will be called SUNHOF.ASC and SUNHOF.ANS 
  236. (ASCII and ANSI versions). The files will be placed in the same directory as 
  237. the HILO.EXE file. 
  238.  
  239. WARNING: The HOF files are cumulative files. That means they are read in each
  240.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  241.          the record of prior months winners!!!!
  242.  
  243.  
  244.  
  245.                           BLACKOUT PERIODS
  246.                           ________________
  247.  
  248.       Use the Blackout ranges option to define up to 5 time periods during
  249.       which you DO NOT want the Door to be played. If a caller tries to access
  250.       the Door during the Blackout period, they will be shown a message that
  251.       contains ALL the Blackout periods you have defined, and to try the Door
  252.       at a later time.
  253.  
  254.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  255.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  256.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  257.  
  258.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  259.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  260.                    a Blackout range.
  261.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  262.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  263.  
  264.  
  265.                           PLAYS Per DAY/DOOR Time
  266.                           _______________________
  267.  
  268.       Plays Per Day and Door Time can be controlled several ways:
  269.  
  270.       (1) You can use the Games Per Day, singular option, in the config
  271.           file above. This option, will affect ALL callers whose Security
  272.           Level is NOT defined in any of the 10 optional Security Level/
  273.           Plays Per Day entries in the config file.
  274.  
  275.       (2) You can use the Door Time, singular option, in the config file
  276.           above. This option, will affect ALL callers whose Security
  277.           Level is NOT defined in any of the 10 optional Security Level/
  278.           Plays Per Day/Door Time entries in the config file.
  279.  
  280.       (3) You can restrict the number of games a specific Security Level
  281.           will be allowed to play per day or REWARD specific Levels with
  282.           more Plays Per Day.
  283.  
  284.           Likewise, you can restrict the Play time for a specific Security
  285.           Level or REWARD specific Levels with more Door Time.
  286.  
  287.           These options are handled by the use of the 10 config
  288.           entries (000=00/00).
  289.  
  290.           The format of each entry is as follows:
  291.  
  292.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  293.                      where =  is a constant and MUST be included
  294.                      where YY is the # of games per day (must be 2 digits)
  295.                      where / is a constant and MUST be included
  296.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  297.  
  298.           If the callers Security Level is NOT defined, his/her Plays Per
  299.           Day and Door Time will be controlled by the values in items
  300.           (1) and (2), above, respectively..
  301.  
  302.           You may define up to 10 Security Levels. All unused entries must
  303.           be defined as   00=00/00
  304.         --------------------------------------------------------------------
  305.           Example: Suppose you had 3 Security Levels defined on your BBS as
  306.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  307.           wanted to set Plays Per Day as :     Subscriber=5
  308.                                            Visiting Sysop=2
  309.                                                   CoSysop=3
  310.                                                    Friend=10
  311.  
  312.           and Door Time as follows:     Subscriber=30 minutes
  313.                                     Visiting Sysop=20 minutes
  314.                                            CoSysop=10 minutes
  315.                                             Friend=remaining call time
  316.  
  317.  
  318.           You would set the Individual "Games per Day" config entry to 1 and
  319.           the individual "Door Time" to 5 minutes (these would be the
  320.           default number of games and default Time for all Security Levels
  321.           other than 20,30 or 40... make them any number you want). Next you
  322.           would replace 4 of the Security Level entries as :  020=05/30
  323.                                                               030=02/20
  324.                                                               040=03/10
  325.                                                               090=10/0
  326.  
  327.  
  328.  
  329.  
  330.  
  331.                         Player-to-Player MESSAGES
  332.                         -------------------------
  333.  
  334. In the REGISTERED version of the Door, your players will be able to send 
  335. messages back and forth to each other. All messages are PRIVATE and all 
  336. messages are maintained within the Door itself and havs no connection to the 
  337. BBS' message bases. The Message file (HILO.MSG) will be restarted when the 
  338. Door game restarts at the beginning of each month. If you do not restart your 
  339. games on the first of each month then you must manually delete the MSG file. 
  340. The file will continue to grow if not deleted and restarted.
  341.  
  342.  
  343.                         INTER-BBS OPTION
  344.                         ----------------
  345.  
  346. The Inter-BBS option is used when you are looking for a way to expand the HILO 
  347. competition beyond just running it on your BBS alone. With this option you can 
  348. join with any number of other BBS' to create some very 'heated' scoring 
  349. competition and exchange messages.
  350.  
  351. The Inter-BBS option has its own High Score file and when High Scores are 
  352. displayed, on participating BBS', the name of the BBS on which the score was 
  353. obtained will also be displayed. At the end of the month, the Inter-BBS scores 
  354. will be reset automatically and a winner will be determined and displayed as 
  355. part of the High Score display in the next month.
  356.  
  357. This option requires that the Door be registered.
  358.  
  359. The InterBBS files (EXE, HIS, DOC, etc) can be found in the included file 
  360. called IBBSxx.ZIP (xx = version). Updates to this file will always be found on 
  361. the SUNRISE-80 BBS and many other BBS'.
  362.  
  363. The Inter-BBS option uses the 'HUB' and 'NODE' concept. The 'HUB' is the 
  364. central/controlling BBS to whom all the other BBS' ('NODES') upload/transfer 
  365. their score files. The 'HUB' then merges all score files and makes a merged 
  366. file available for the 'NODES' to download/transfer.
  367.  
  368.  
  369.                         NON-STANDARD COM SUPPORT
  370.                         ________________________
  371.  
  372.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  373.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  374.       number after the configuration filename. Let's assume your Door is
  375.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  376.       passed to your Door would be:
  377.  
  378.                             FOOBAR FOOBAR.CFG /5
  379.  
  380.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  381.       normally used with COM1. No /x parameter is needed for the standard
  382.       IRQ's.
  383.  
  384.       As an alternative, you may use an environmental variable on the command
  385.       line. To use the variable (following the example above), place a
  386.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  387.       different IRQ number for each node). The command line would now look
  388.       like this:
  389.  
  390.                           FOOBAR FOOBAR.CFG /%IRQ%
  391.  
  392.       This, in combination with the use of the environmental variables
  393.       described in the MULTI-NODE SETUP section will allow you to use one
  394.       batch file and one config file to run this door on all nodes.
  395.  
  396.  
  397.  
  398.  
  399.                            MULTI-NODE SETUP
  400.                            ________________
  401.  
  402.       All Sunrise Doors are Multi-Node capable. Each node must have the
  403.       ability to access a configuration file which will have its own system
  404.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  405.       line. There are 2 ways to accomplish this:
  406.  
  407.       (1) Create a separate configuration file for each node. The only
  408.           difference between each file would be the location of the system
  409.           file for that particular node. For example, on my system there are 2
  410.           nodes and the first line of the config files would look like this:
  411.  
  412.                         NODE1:  H:\PCB1\DOOR.SYS
  413.                         NODE2:  H:\PCB2\DOOR.SYS
  414.  
  415.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  416.  
  417.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  418.           the following PCBoard/Wildcat environmental variables:
  419.  
  420.                  PCBDIR    (Directory containing the System file)
  421.                  PCBDRIVE  (Drive containing the System file)
  422.                  WCNODEID  (Active Node Number)
  423.  
  424.           Thus, the first line of the SINGLE configuration file, for this Door
  425.           would look like this:
  426.  
  427.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  428.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  429.  
  430.       NOTE: This option, as described, assumes that you are running PCB or
  431.             Wildcat software. The environmental variables are automatically
  432.             created by the software for each node.
  433.  
  434.             HOWEVER, if you are running other BBS software you should be able
  435.             to set the variables EXACTLY as described below, for EACH node
  436.             (more than likely in each batch file you use to bring up EACH node):
  437.  
  438.                             PCBDRIVE=C:
  439.                             ^^^^^^^^^
  440.                             PCBDIR=\NODE2
  441.                             ^^^^^^^^
  442.  
  443.             Info with a carat (^) under it, MUST be typed as is. The rest
  444.             depends on your naming conventions.
  445.  
  446.             This, in combination with the use of the optional environmental
  447.             variable described in the NON-STANDARD COM SUPPORT section, will
  448.             allow you to use one batch file and one config file to run this
  449.             door on all nodes.
  450.  
  451.  
  452.                                ADOPT-A-DOOR
  453.                                ____________
  454.  
  455.     Having been a Sysop for a number of years, I have had my share of problems
  456.     and frustrations getting financial support for my board's upkeep. A fellow
  457.     Sysop left a message on my board, not long ago, about a concept that was
  458.     being used by several boards around the country.
  459.  
  460.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  461.     would be the same as sending in a donation, only this way it is earmarked
  462.     for registering a particular door. In a way, the user feels he/she is
  463.     "getting something in return". As a Door author I have decided to build
  464.     this concept into each of my Door programs. The concept replaces the
  465.     usual message "tell the Sysop to register this Door" we find in most
  466.     doors.
  467.  
  468.     If the Door is unregisterd then a message appears on the opening screen
  469.     to that effect. After finishing or suspending a game, a message screen
  470.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  471.     caller to contact the Sysop to find out if there is any further details
  472.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  473.     time, etc to callers that ADOPT-A-DOOR.
  474.  
  475.     If the Door has been registered, either by the Sysop or other callers,
  476.     the names of those contributors will be displayed in the closing screen.
  477.  
  478.     NOTE: If you want to display the names of the callers that contributed
  479.           to registering the Door, you must create an ASCII file called
  480.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  481.           the name(s) of the contributors (one on each line, maximum of 5
  482.           entries, each a maximum of 30 characters long). This file must be
  483.           saved, in ASCII format, and placed in the Door directory.
  484.  
  485.  
  486.  
  487.                               LEGALITIES
  488.                               __________
  489.  
  490.  
  491.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  492.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  493.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  494.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  495.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  496.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  497.       OR BREACH OF ANY WARRANTY.
  498.  
  499.  
  500.  
  501.  
  502.  
  503.                              DISTRIBUTION
  504.                              ____________
  505.  
  506.    You may make this file available for downloading from your BBS or you may
  507.    upload it to any BBS of your choice, provided that you do not make any
  508.    changes to the contents of the archive (ZIP file). The archive and its
  509.    individual contents may not be used by any service that charges any money
  510.    whatsoever, without the written permission of the author.
  511.  
  512.  
  513.  
  514.  
  515.  
  516.                              REGISTRATION
  517.                              ____________
  518.  
  519.    Registration and the subsequent insertion of the registration number into
  520.    your configuation file, allows for the display of your BBS name on the
  521.    opening and closing screen as well as the reduction of a delay built into
  522.    the opening screen display along with the ability to change certain
  523.    values in the configuration file.
  524.  
  525.    To register your copy of HILO, please fill out the registration form
  526.    (REGISTER.FRM) and mail it along with the registration fee to
  527.    the name and address on the form.
  528.  
  529.    Once a door is registered, any changes to registration information (Sysop
  530.    name or BBS Name) will require the doors to be re-registered at the
  531.    registration fee in effect at that time.
  532.  
  533.    Be sure to use the proper upper/lower case when filling in your name and
  534.    BBS name, as they MUST match the way you entered them in the configuration
  535.    file.             ^^^^
  536.  
  537.    Based upon information supplied on the registration form, I will pre-
  538.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  539.    up your registration number.
  540.  
  541.  
  542.  
  543.                                  MISC
  544.                                  ____
  545.  
  546.    The latest version of HILO and other fine SUNRISE DOOR programs are
  547.    always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  548.  
  549.    Remember, should you have any problems, questions or suggestions, be sure
  550.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  551.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  552.  
  553.